/**
 * Copyright 2009 the original author or authors.
 *
 * Licensed under the GPL License, Version 3.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.gnu.org/licenses/lgpl-3.0.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.guardianapis.api.util;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * This provides utility methods for use with JUnit unit testing
 * 
 * @author michael.lee
 */
public final class BannerUtils {

	/*******************************************************************************
	 * Constants
	 *******************************************************************************/

	private static Log log = LogFactory.getLog(BannerUtils.class);
	
	/*******************************************************************************
	 * Constructors
	 *******************************************************************************/

	private BannerUtils() {
		// Hiding the default constructor
	}
	
	/*******************************************************************************
	 * Public Methods
	 *******************************************************************************/

	public static String generateBanner(Object pTestClassObject, String pTestName) {
		return "\n\n" 
			+ "*********************************************************************************\n"
			+ "* TESTCASE: " + getClassName(pTestClassObject.getClass()) + "." + pTestName + " \n"
			+ "*********************************************************************************\n";
	}

	/*******************************************************************************
	 * Private Methods
	 *******************************************************************************/
	
	@SuppressWarnings("unchecked")
	public static String getClassName(Class pClass) {
	    String fullClassName = pClass.getName();
	    String className = fullClassName;
	    
	    int lastPackageMarkerIndex = fullClassName.lastIndexOf(".") + 1;
	    if (lastPackageMarkerIndex > 0) {
	    	className = fullClassName.substring(lastPackageMarkerIndex);
	    }
	    
	    log.debug("The short version of class: " + pClass.getName() + " is: " + className);
	    return className;
    }
	
}
